Skip to content

Add AGENTS.md with guidelines #7093

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
May 20, 2025
Merged

Add AGENTS.md with guidelines #7093

merged 1 commit into from
May 20, 2025

Conversation

@joaquim-verges
Copy link
Member

@joaquim-verges joaquim-verges commented May 20, 2025 •
edited by pr-codex bot
Loading

PR-Codex overview

This PR introduces the Codex Agent Guidelines for the thirdweb-dev/js repository, outlining coding standards, architectural decisions, and workflow conventions for contributors.

Detailed summary

  • Added guidelines for GitHub workflow and etiquette.
  • Established formatting and linting rules using Biome.
  • Introduced a TypeScript Style Guide.
  • Defined testing strategies and co-location of tests.
  • Specified public API surface and performance practices.
  • Outlined styling conventions and component patterns for apps/dashboard and apps/playground.
  • Provided data fetching guidelines for server and client sides.
  • Emphasized performance tracking and bundle size management.
  • Included documentation and developer experience best practices.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@vercel
Copy link

vercel bot commented May 20, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 7:24am
login ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 7:24am
thirdweb_playground ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 7:24am
thirdweb-www ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 7:24am
wallet-ui ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 7:24am

@joaquim-verges joaquim-verges changed the title Add AGENTS.md with guidelines for AI copilots Add AGENTS.md with guidelines May 20, 2025
@joaquim-verges Graphite App
Copy link
Member Author

joaquim-verges commented May 20, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@joaquim-verges joaquim-verges marked this pull request as ready for review May 20, 2025 07:17
@joaquim-verges joaquim-verges merged commit 6cf92c6 into main May 20, 2025
19 of 22 checks passed
@joaquim-verges joaquim-verges deleted the Add_AGENTS.md_with_guidelines_for_AI_copilots branch May 20, 2025 07:18
@codecov
Copy link

codecov bot commented May 20, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.81%. Comparing base (89ccc80) to head (d43366e).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main    #7093   +/-   ##
=======================================
  Coverage   55.81%   55.81%           
=======================================
  Files         900      900           
  Lines       57848    57848           
  Branches     4077     4077           
=======================================
  Hits        32286    32286           
  Misses      25457    25457           
  Partials      105      105
Flag Coverage Δ
packages 55.81% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link
Contributor

github-actions bot commented May 20, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 56.59 KB (0%) 1.2 s (0%) 147 ms (+104.8% 🔺) 1.3 s
thirdweb (cjs) 304.45 KB (0%) 6.1 s (0%) 546 ms (-4.92% 🔽) 6.7 s
thirdweb (minimal + tree-shaking) 5.69 KB (0%) 114 ms (0%) 48 ms (+907.96% 🔺) 162 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 25 ms (+1632.55% 🔺) 35 ms
thirdweb/react (minimal + tree-shaking) 19.51 KB (0%) 391 ms (0%) 61 ms (+379.8% 🔺) 451 ms

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@joaquim-verges joaquim-verges

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@joaquim-verges